home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / pmdaespping.z / pmdaespping
Encoding:
Text File  |  2002-10-03  |  10.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))                                                  PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg - generic probe performance metrics domain agent
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg [----CCCC] [----dddd _d_o_m_a_i_n] [----llll _l_o_g_f_i_l_e] [----IIII
  13.      _i_n_t_e_r_v_a_l] [----tttt _t_i_m_e_o_u_t] _c_o_n_f_i_g_f_i_l_e
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is a Performance Metrics Domain Agent (PMDA) which exports
  17.      quality of service and response time measurements for arbitrary commands
  18.      as might be run from a shell such as sssshhhh(1).
  19.  
  20.      These measurements are intended to be used to quantify service quality
  21.      and service availability for those services that are either mission
  22.      critical or act as early indicators of adverse system performance.  For
  23.      these reasons, ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is used to provide service probe capabilities
  24.      for the System Group Management (SGM) component of the Embedded Support
  25.      Partner (ESP) tools.
  26.  
  27.      The sample configuration can be used to monitor various services, both
  28.      locally and remotely, such as ICMP response (using ppppiiiinnnngggg(1)), DNS lookup
  29.      via nnnnssssllllooooooookkkkuuuupppp(1), bind/portmapper service using rrrrppppccccbbbbiiiinnnndddd(1), SMTP by
  30.      connecting to telnet port 25 and sending an ``expn root'' request, NNTP
  31.      by connecting to telnet port 119 and running a ``listgroup'' command, and
  32.      numerous others.
  33.  
  34.      It is expected that other commands would follow the examples in the
  35.      sample configuration files (see the ``FILES'' section below).
  36.  
  37.      A brief description of the ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg command line options follows:
  38.  
  39.      ----CCCC   Parse _c_o_n_f_i_g_f_i_l_e, reporting any errors and exiting with non-zero
  40.           status if the file contains syntactical errors.
  41.  
  42.      ----dddd   It is absolutely crucial that the performance metrics _d_o_m_a_i_n number
  43.           specified here is unique and consistent.  That is, _d_o_m_a_i_n should be
  44.           different for every PMDA on the one host, and the same _d_o_m_a_i_n number
  45.           should be used for the same PMDA on all hosts.
  46.  
  47.      ----llll   Location of the log file.  By default, a log file named _e_s_p_p_i_n_g._l_o_g
  48.           is written in the current directory of ppppmmmmccccdddd(1) when ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is
  49.           started, i.e.  $$$$PPPPCCCCPPPP____LLLLOOOOGGGG____DDDDIIIIRRRR////ppppmmmmccccdddd.  If the log file cannot be created
  50.           or is not writable, output is written to the standard error instead.
  51.  
  52.      ----IIII   Amount of time (in seconds) between subsequent executions of the
  53.           list of commands provided via the configuration file _c_o_n_f_i_g_f_i_l_e.
  54.           The default is 2 minutes.
  55.  
  56.      ----tttt   Amount of time (in seconds) to wait before timing out awaiting a
  57.           response for a command from _c_o_n_f_i_g_f_i_l_e.  The default is 20 seconds.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))                                                  PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))
  71.  
  72.  
  73.  
  74.      The required _c_o_n_f_i_g_f_i_l_e specifies ``tag'' and ``command'' pairs, each on
  75.      a separate line.  All of the commands are run one after another, with the
  76.      whole group rescheduled to be run once per _i_n_t_e_r_v_a_l.  For each command
  77.      that is run, ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg records information related to the success (or
  78.      timeout), exit status, elapsed time and CPU time (system and user), and
  79.      this information is exported by the PMDA.  The tags are used to identify
  80.      the individual commands amongst the values exported by the PMDA, and form
  81.      the external instance domain identifiers for the ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg metrics
  82.      which relate to each command.
  83.  
  84. IIIINNNNSSSSTTTTAAAALLLLLLLLAAAATTTTIIIIOOOONNNN
  85.      In order for a host to export the names, help text and values for the
  86.      espping performance metrics, do the following as root:
  87.  
  88.           # cd $PCP_PMDAS_DIR/espping
  89.           # cp sample.map sgm.map
  90.           # vi sgm.map
  91.           # ./Configure
  92.  
  93.      The map file which is passed in to the Configure script associates host
  94.      names with services to be monitored on each hostname.  The list of
  95.      services is contained in the file $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////tttteeeemmmmppppllllaaaatttteeee....ccccoooonnnnffff,
  96.      and this file can be extended with customized service probe mechanisms.
  97.  
  98.      The set of ``tag'' and ``command'' pairs may be generated via the
  99.      Configure script (as above), or specified from a default (sample)
  100.      configuration file, a customized file or entered interactively as part of
  101.      the Install script (use of the Install script is automated using
  102.      Configure).
  103.  
  104.      If you want to undo the installation, do the following as root:
  105.  
  106.           # cd $PCP_PMDAS_DIR/espping
  107.           # ./Remove
  108.  
  109.      ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is launched by ppppmmmmccccdddd(1) and should never be executed directly.
  110.      The Install and Remove scripts notify ppppmmmmccccdddd(1) when the agent is installed
  111.      or removed.
  112.  
  113. FFFFIIIILLLLEEEESSSS
  114.      $$$$PPPPCCCCPPPP____PPPPMMMMCCCCDDDDCCCCOOOONNNNFFFF____PPPPAAAATTTTHHHH
  115.                command line options used to launch ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  116.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////hhhheeeellllpppp
  117.                default help text file for the espping metrics
  118.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////tttteeeemmmmppppllllaaaatttteeee....ccccoooonnnnffff
  119.                template configuration file with a number of common service
  120.                probe mechanisms
  121.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////ssssaaaammmmpppplllleeee....mmmmaaaapppp
  122.                example mapping file for configuring which services to monitor,
  123.                and at which hosts
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))                                                  PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))
  137.  
  138.  
  139.  
  140.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////ssssaaaammmmpppplllleeee....ccccoooonnnnffff
  141.                example configuration file with a number of common commands
  142.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////CCCCoooonnnnffffiiiigggguuuurrrreeee
  143.                installation script for ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  144.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////IIIInnnnssssttttaaaallllllll
  145.                direct installation script (bypass Configure) for ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  146.      $$$$PPPPCCCCPPPP____PPPPMMMMDDDDAAAASSSS____DDDDIIIIRRRR////eeeessssppppppppiiiinnnngggg////RRRReeeemmmmoooovvvveeee
  147.                undo installation script for ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  148.      $$$$PPPPCCCCPPPP____LLLLOOOOGGGG____DDDDIIIIRRRR////ppppmmmmccccdddd////eeeessssppppppppiiiinnnngggg....lllloooogggg
  149.                default log file for error messages and other information from
  150.                ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  151.  
  152. PPPPCCCCPPPP EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  153.      Environment variables with the prefix PPPPCCCCPPPP____ are used to parameterize the
  154.      file and directory names used by PCP.  On each installation, the file
  155.      ////eeeettttcccc////ppppccccpppp....ccccoooonnnnffff contains the local values for these variables.  The
  156.      $$$$PPPPCCCCPPPP____CCCCOOOONNNNFFFF variable may be used to specify an alternative configuration
  157.      file, as described in ppppccccpppp....ccccoooonnnnffff(4).
  158.  
  159. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  160.      ppppmmmmccccdddd(1)
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.